Video Translation (preview:2024-05-20)

2025/06/06 • 6 updated methods

TranslationOperations_ListTranslation (updated)
Description :  List translation resources.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TranslationOperations_ListTranslation",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "input": [
              {
                "#name": "sourceLocale",
                "Description": {
                  "new": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20.",
                  "old": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts."
                }
              },
              {
                "#name": "videoFileUrl",
                "Description": {
                  "new": "Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive\u2014only one of them is required. If both are provided, the request will be considered invalid.",
                  "old": "Translation video file url."
                }
              },
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not provided, it will be auto-detected from the video file.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not provided, it will use the language dependent default value.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file.",
                  "old": "Export subtitle in video."
                }
              }
            ],
            "latestIteration": [
              {
                "input": [
                  {
                    "#name": "speakerCount",
                    "Description": {
                      "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                      "old": "Number of speakers in the video."
                    }
                  },
                  {
                    "#name": "subtitleMaxCharCountPerSegment",
                    "Description": {
                      "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                      "old": "Subtitle max display character count per segment."
                    }
                  },
                  {
                    "#name": "exportSubtitleInVideo",
                    "Description": {
                      "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                      "old": "Export subtitle in video."
                    }
                  }
                ]
              }
            ],
            "latestSucceededIteration": [
              {
                "input": [
                  {
                    "#name": "speakerCount",
                    "Description": {
                      "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                      "old": "Number of speakers in the video."
                    }
                  },
                  {
                    "#name": "subtitleMaxCharCountPerSegment",
                    "Description": {
                      "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                      "old": "Subtitle max display character count per segment."
                    }
                  },
                  {
                    "#name": "exportSubtitleInVideo",
                    "Description": {
                      "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                      "old": "Export subtitle in video."
                    }
                  }
                ]
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /translations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Translation items on this page ,
Required: True ,
}
[
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: True ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: True ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TranslationOperations_GetTranslation (updated)
Description :  Fetch a translation by ID.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TranslationOperations_GetTranslation",
  "$responses": {
    "200": {
      "$properties": {
        "input": [
          {
            "#name": "sourceLocale",
            "Description": {
              "new": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20.",
              "old": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts."
            }
          },
          {
            "#name": "videoFileUrl",
            "Description": {
              "new": "Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive\u2014only one of them is required. If both are provided, the request will be considered invalid.",
              "old": "Translation video file url."
            }
          },
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not provided, it will be auto-detected from the video file.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not provided, it will use the language dependent default value.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file.",
              "old": "Export subtitle in video."
            }
          }
        ],
        "latestIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ],
        "latestSucceededIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /translations/{translationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: True ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: True ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
TranslationOperations_CreateTranslation (updated)
Description :  Creates a translation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "TranslationOperations_CreateTranslation",
  "$parameters": {
    "resource": {
      "$properties": {
        "input": [
          {
            "#name": "sourceLocale",
            "Description": {
              "new": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20.",
              "old": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts."
            }
          },
          {
            "#name": "videoFileUrl",
            "Description": {
              "new": "Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive\u2014only one of them is required. If both are provided, the request will be considered invalid.",
              "old": "Translation video file url."
            }
          },
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not provided, it will be auto-detected from the video file.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not provided, it will use the language dependent default value.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file.",
              "old": "Export subtitle in video."
            }
          }
        ],
        "latestIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ],
        "latestSucceededIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "input": [
          {
            "#name": "sourceLocale",
            "Description": {
              "new": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20.",
              "old": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts."
            }
          },
          {
            "#name": "videoFileUrl",
            "Description": {
              "new": "Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive\u2014only one of them is required. If both are provided, the request will be considered invalid.",
              "old": "Translation video file url."
            }
          },
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not provided, it will be auto-detected from the video file.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not provided, it will use the language dependent default value.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file.",
              "old": "Export subtitle in video."
            }
          }
        ],
        "latestIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ],
        "latestSucceededIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "input": [
          {
            "#name": "sourceLocale",
            "Description": {
              "new": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20.",
              "old": "The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts."
            }
          },
          {
            "#name": "videoFileUrl",
            "Description": {
              "new": "Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive\u2014only one of them is required. If both are provided, the request will be considered invalid.",
              "old": "Translation video file url."
            }
          },
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not provided, it will be auto-detected from the video file.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not provided, it will use the language dependent default value.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file.",
              "old": "Export subtitle in video."
            }
          }
        ],
        "latestIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ],
        "latestSucceededIteration": [
          {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /translations/{translationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
Operation-Id:
{
Description: Operation ID. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: True ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: True ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Create translation resource for hosting iterations of translating one video file from source locale to target locale. ,
}
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: True ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: True ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Create translation resource for hosting iterations of translating one video file from source locale to target locale. ,
}
{
id:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
input:
{
Description: Translation input. ,
Required: True ,
}
{
sourceLocale:
{
Description: The source locale of the video file. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts , if not specified, the source locale will be auto-detected from the video file, the auto detect is only supported after version 2025-05-20. ,
Required: True ,
}
string ,
targetLocale:
{
Description: The target locale of the translation. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts. ,
Required: True ,
}
string ,
voiceKind:
{
Description: Translation voice kind. ,
Enum:
{
PlatformVoice: TTS platform voice ,
PersonalVoice: TTS personal voice ,
}
,
Required: True ,
}
enum ,
videoFileUrl:
{
Description: Translation video file Azure blob url, .mp4 file format, maxmum 5GB file size and 4 hours video duration. Provide the input media file using either videoFileUrl or audioFileUrl, these parameters are mutually exclusive—only one of them is required. If both are provided, the request will be considered invalid. ,
Format: uri ,
Required: True ,
}
string ,
speakerCount:
{
Description: Number of speakers in the video, if not provided, it will be auto-detected from the video file. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not provided, it will use the language dependent default value. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, the default value is false, it will not burn subtitle to the translated video file. ,
Required: False ,
}
boolean ,
}
,
displayName:
{
Description: Translation display name. ,
Required: False ,
}
string ,
description:
{
Description: Translation description. ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
latestIteration:
{
Description: Latest iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
latestSucceededIteration:
{
Description: Latest completed iteration of the translation. ,
Required: False ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
failureReason:
{
Description: Translation failure reason ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IterationOperations_ListIteration (updated)
Description :  List Iteration resources.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IterationOperations_ListIteration",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "input": [
              {
                "#name": "speakerCount",
                "Description": {
                  "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Number of speakers in the video."
                }
              },
              {
                "#name": "subtitleMaxCharCountPerSegment",
                "Description": {
                  "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Subtitle max display character count per segment."
                }
              },
              {
                "#name": "exportSubtitleInVideo",
                "Description": {
                  "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
                  "old": "Export subtitle in video."
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /translations/{translationId}/iterations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
top:
{
Description: The number of result items to return. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: The number of result items to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
maxpagesize:
{
Description: The maximum number of result items per page. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The Iteration items on this page ,
Required: True ,
}
[
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IterationOperations_GetIteration (updated)
Description :  Fetch a iteration by ID.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IterationOperations_GetIteration",
  "$responses": {
    "200": {
      "$properties": {
        "input": [
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Export subtitle in video."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /translations/{translationId}/iterations/{iterationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
iterationId:
{
Description: Iteration ID ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
IterationOperations_CreateIteration (updated)
Description :  Creates an iteration.
Reference :  Link ¶

⚶ Changes

{
  "#id": "IterationOperations_CreateIteration",
  "$parameters": {
    "resource": {
      "$properties": {
        "input": [
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Export subtitle in video."
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "input": [
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Export subtitle in video."
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "input": [
          {
            "#name": "speakerCount",
            "Description": {
              "new": "Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Number of speakers in the video."
            }
          },
          {
            "#name": "subtitleMaxCharCountPerSegment",
            "Description": {
              "new": "Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Subtitle max display character count per segment."
            }
          },
          {
            "#name": "exportSubtitleInVideo",
            "Description": {
              "new": "Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation.",
              "old": "Export subtitle in video."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /translations/{translationId}/iterations/{iterationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
translationId:
{
Description: Translation resource ID. ,
Required: True ,
}
string ,
iterationId:
{
Description: Iteration ID ,
Required: True ,
}
string ,
Operation-Id:
{
Description: Operation ID. ,
Required: True ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter. ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
}
,
$schema:
{
Description: Do one iteration to translate one video file from source locale to target locale, webvtt for content editing is optional for requesting parameter. ,
}
{
id:
{
Description: Iteration ID ,
Required: True ,
}
string ,
input:
{
Description: Iteration input. ,
Required: True ,
}
{
webvttFile:
{
Description: Webvtt file for content editing, this parameter is required from the second iteration creation request of the translation. ,
Required: False ,
}
{
url:
{
Description: Translation webvtt file url. ,
Format: uri ,
Required: True ,
}
string ,
kind:
{
Description: Translation webvtt file kind. ,
Enum:
{
SourceLocaleSubtitle: Source locale plain text subtitle webvtt file ,
TargetLocaleSubtitle: Target locale plain text subtitle webvtt file ,
MetadataJson: Target locale metadata JSON webvtt file ,
}
,
Required: True ,
}
enum ,
}
,
speakerCount:
{
Description: Number of speakers in the video, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
subtitleMaxCharCountPerSegment:
{
Description: Subtitle max display character count per segment, if not specified, it will inherit the value defined in the input of translation creation. ,
Format: int32 ,
Required: False ,
}
integer ,
exportSubtitleInVideo:
{
Description: Export subtitle in video, if not specified, it will inherit the value defined in the input of translation creation. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Iteration description ,
Required: False ,
}
string ,
status:
{
Description: Iteration status ,
Enum:
{
NotStarted: Not started status ,
Running: Running status ,
Succeeded: Run succeeded status ,
Failed: Run failed status ,
Canceled: Cancelled status ,
}
,
Required: False ,
}
enum ,
failureReason:
{
Description: Iteration failure reason ,
Required: False ,
}
string ,
createdDateTime:
{
Description: The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
result:
{
Description: Iteration result. ,
Required: False ,
}
{
translatedVideoFileUrl:
{
Description: Translated video file URL. ,
Format: uri ,
Required: False ,
}
string ,
sourceLocaleSubtitleWebvttFileUrl:
{
Description: Source locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
targetLocaleSubtitleWebvttFileUrl:
{
Description: Target locale subtitle file URL. ,
Format: uri ,
Required: False ,
}
string ,
metadataJsonWebvttFileUrl:
{
Description: Metadata json webvtt file URL. ,
Format: uri ,
Required: False ,
}
string ,
reportFileUrl:
{
Description: Report file URL. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}